fundingDownload
HTTP method: GET
This is the API call to download a specific funding when found using the fundingList call.
Test URL | https://testgateway.altapaysecure.com/merchant/API/<method> |
Production URL | https://<YourShopName>.altapaysecure.com/merchant/API/<method> |
The fundingDownload method returns a comma separated value (CSV) file with the details of a funding.
To call the fundingDownload method, you need to use the URL returned in the <DownloadLink> parameter in the response from the fundingList method. For more information, see fundingList.
Column Name | Description | Type |
---|---|---|
Date |
The Datevalue is the settlement date of the transaction, which is the date when the transaction is processed within the Visa or MasterCard networks. Typically this is the bank day following the date of the payment/refund. |
YYYY-MM-DD |
Type | The type of the funding. |
payment refund adjustment rolling roundoff fee unknown payment_rejected refund_rejected |
ID | The identification number as defined by the acquirer. | string(100) |
Reconciliation Identifier * | A unique ID of the funding record, if the record is related to a transaction. | UUID |
Payment * | AltaPay's payment ID. Only available if the transaction is related to a funding. | [0-9a-f](1-40) |
Order * | The shop order ID. Only available if the transaction is related to a funding | string(100) |
Terminal * | The terminal name. Only available if the transaction is related to a funding | string(100) |
Shop * | The shop name. Only available if the transaction is related to a funding | string(100) |
Transaction Currency | The currency of the original payment in the ISO-4217 format. | string(3) |
Transaction Amount | The original payment amount. | float |
Exchange Rate |
The exchange rate between the transaction and funding amounts. An exchange rate of 1 to 1 is represented by a value of 100. |
float |
Settlement Currency | The currency of the settlement record, ISO-4217 | string(3) |
Settlement Amount | The settlement amount. | float |
Fixed Fee | The fixed transaction cost, including VAT (Value Added Tax) where applicable. | float |
Fixed Fee VAT | The VAT of the fixed transaction cost | float |
Rate Based Fee | The rate based transaction cost, including VAT (Value Added Tax) where applicable. | float |
Rate Based Fee VAT | The VAT of the rate based transaction cost | float |
GET call
https://<YourShopName>.altapaysecure.com/merchant/API/fundingDownload?id=32
Example result
Date | Type | ID | Reconciliation Identifier | Payment | Order | Terminal | Shop | Transaction Currency | Transaction Amount | Exchange Rate | Settlement Currency | Settlement Amount | Fixed Fee | Fixed Fee VAT | Rate Based Fee | Rate Based Fee VAT |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2010-09-22 00:00 | payment | 5 | 3f664acc-c71d-45e6-8c6a-a15838451a77 | 5 | settlement functional4c9a127b159a0 | AltaPay Test Terminal | AltaPay Functional Test Shop | EUR | 50.00 | 100.000000 | EUR | 50.00 |
Date;Type;ID;"Reconciliation Identifier";Payment;Order; Terminal;Shop;"Transaction Currency";"Transaction Amount";"Exchange Rate";"Settlement Currency";"Settlement Amount";"Fixed Fee";"Fixed Fee VAT";"Rate Based Fee";"Rate Based Fee VAT" "2010-09-22 00:00:00";payment;5;3f664acc-c71d-45e6-8c6a-a15838451a77;5;"settlement functional4c9a127b159a0";"AltaPay Test Terminal";"AltaPay Functional Test Shop";EUR;50.00;100.000000;EUR;50.00;;;;